home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_1
/
fnls100.zip
/
FNLSCAN.DOC
< prev
next >
Wrap
Text File
|
1993-03-21
|
15KB
|
344 lines
╖──── ╖────╖ ╖ ╓───
║ ║ ║ ║ ║
║─── ║ ║ ║ ╙───╖ ╓─── ──╖ ╖──╖
║ ║ ║ ║ ║ ║ ╓──║ ║ ║
╜ ╜ ╜ ╜──── ────╜ ╙─── ╙──╜ ╜ ╜
FNLScan Documentation File
Version 1.00
(c) Copyright 1993 - Stacy Smith
Courtesy of:
The Bloom Beacon-Picayune BBS
Node 1: (804) 525-9760 (USRobotics Courier Dual Standard)
Node 2: (804) 525-5372 (USRobotics Courier V.32bis)
FidoNet 1:276/112
Intelec
RoseNet (ID: BB-P)
Stacy Smith
Route 6 Box 189
Forest, Virginia 24551
┌────────────────────┐
│ 1. Introduction: │
└────────────────────┘
FNLScan was developed because many of my users who use Fidonet Netmail kept
coming to me wanting to know if there was a node in such-and-such a place, or
what address this-or-that person was at. While unzipping the nodelist and using
a text editor to search the nodelist, I groused that I wish they could do this
themselves. Now they can using FNLScan, the Fidonet NodeList Scan door.
┌───────────────────────────┐
│ 2. Features of FNLScan: │
└───────────────────────────┘
∙ Scans the standard NODELIST.nnn text file (uncompiled nodelist). This
format was chosen since it is available to all Fidonet systems,
regardless of mailer or BBS software used.
∙ Up to 10 Fidonet-compatible nodelists can be configured for scanning.
∙ Most door text is contained within text files that can be modifed by
the user. This will allow simple customization by the sysop for foreign
language support and different tastes.
∙ Optionally logs all FNLScan operations.
∙ Fully multinode and multiuser compatible.
∙ Supports most BBS software through the use of PCBOARD.SYS, DOOR.SYS,
CALLINFO.BBS and DORINFOx.DEF door drop files.
∙ Supports IRQs 2 through 15 and any COM port address.
∙ Supports FOSSIL drivers.
∙ Supports Digiboard multiport cards.
∙ Written completely in C for optimal speed, using Microsoft C/C++ 7.0.
∙ Lifetime registration; pay ONCE and your registration number will work
on all future versions!
┌─────────────────────────────────────────────────────────┐
│ 3. Files Included in the FNLScan Distribution Archive │
└─────────────────────────────────────────────────────────┘
FNLSCAN.EXE Fidonet NodeList Scan door program
FNLSCAN.CFG Sample configuration file
WELCOME Text door welcome screen file
WELCOMEG Graphics door welcome screen file
MENU Text door menu file
MENUG Graphics door menu file
HELP Text help file
HELPG Graphics help file
CLOSE Text closing file
CLOSEG Graphics closing file
FNLSCAN.DOC This file
HISTORY.TXT FNLScan revision history in reverse order
REGISTER.FRM Registration form for FNLScan
FILE_ID.DIZ Internal description file
When you unzip the distribution archive, you should see my PKZIP authenticity
verification stamp, and a '-AV' after every file in the archive:
# SSU301 The Bloom Beacon-Picayune BBS
If there are any files missing or added, or the -AV stamp is missing, the
archive has been tampered with. It would be advisable to call my BBS (listed at
the top of this document) for the latest version of FNLScan.
┌───────────────────────────┐
│ 4. Program Requirements │
└───────────────────────────┘
To the best of my knowledge, this door will run on most any machine capable of
running a BBS package. My BBS setup is PCBoard 14.5a/10 running under DESQview
on a LANtastic network, but other sysops that I have been in contact with have
successfully implemented FNLScan on a wide variety of hardware.
FNLScan requires DOS 3.x or later, as it uses DOS SHARE-compatible file reads
and writes. FNLScan's memory requirements are very small (about 80K or so), so
it can be run as a shelled door versus a dropped-to-DOS door, if your software
supports such a mode and you choose to do so.
┌───────────────────┐
│ 5. Registration │
└───────────────────┘
FNLScan is not free; nor is FNLScan is crippled to force registration. FNLScan
is fully functional, and will always remain so. The only variation with the
registered copies is no time delay and beg message.
Why register? Besides a clean conscience, you will get a registration code that
will work for all future versions of FNLScan, and will remove the delay and
message displayed upon closing the door.
The registration fee for your unique code is $15 for non-commercial BBSs (not
too bad, eh?). The registration fee for commercial BBSs, defined if you run
your BBS in the course of a commercial business or for profit, is $30. Other
variations are available; refer to the file REGISTER.FRM for all registration
options. Please print the file REGISTER.FRM and fill it out. You can print out
the form by issuing the following command from the DOS prompt:
TYPE REGISTER.FRM > PRN
┌───────────────────────────────────────┐
│ 6. License, Warranty and Disclaimer │
└───────────────────────────────────────┘
I'll keep this part short and sweet, and dispense with the legal-ese:
License: You are allowed to use FNLScan for 30 days, after which you
must either register FNLScan or stop using it completely. FNLScan
registration is a license for your use of FNLScan; I retain
ownership of the software. A single registration applies to a single
BBS system, regardless of the number of computers used in the
system. If you run two or more distinct BBS systems on the same
computer(s) (with different names), you require two or more FNLScan
registrations. Refer to the registration form for the currect
pricing structure.
Warranty: There isn't one. The only thing I'll guarantee is that
FNLScan will take up disk space, and will disappear when deleted.
Disclaimer: I'm not responsible for anything bad that happens. FNLScan
works here, but I cannot be held responsible for it not working on
your computer or doing any damage to hardware or software.
If these aren't agreeable with you, then the best thing to do is delete FNLScan
right now. I'll do my best to help any user (registered or not) that wants to
use FNLScan, and I'll act on bug reports quickly, but I simply cannot and will
not be responsible for anything bad, like lost data, disk crashes, or whatever
else you can think of.
┌───────────────────┐
│ 7. Installation │
└───────────────────┘
GENERAL INSTALLATION:
─────────────────────
Make a subdirectory on your hard drive. For the purposes of this document,
we'll call it "C:\FNLSCAN". Unarchive the FNLScan distribution archive into
this subdirectory. You've more than likely already made it this far, if you're
reading this file. <grin>
The FNLScan system opens several files simultaneously for various reasons. I
would recommend that you have a minimum of FILES=40 per node in your system
CONFIG.SYS file, since FNLScan is run in conjunction with your BBS software.
If you are running under a network or a multitasking operating system, you
should already have DOS's SHARE.EXE loaded. You must have SHARE loaded in order
to take advantage of the file sharing and locking methods used by the FNLScan
program to prevent data loss. (If you are running a single-node system without
a multitasker, SHARE is not needed).
Edit the configuration file to suit your needs. Proper configuration will
require you to refer to this section, the previous section and the section
titled "Configuration", which has an in-depth explanation of each configuration
parameter and its function.
Note that for the FNLScan program, you can obtain a limited program syntax
screen simply by executing the program name "FNLSCAN".
INSTALLATION INTO YOUR BBS SOFTWARE:
────────────────────────────────────
FNLScan must be run from its own subdirectory; this is required so it can find
the text files required for display. Only two command-line parameters are
required for FNLScan:
FNLSCAN -Cfnlscan.cfg -Dc:\bbs\door.sys
where -C defines the configuration file for FNLScan, and -D is the complete
path and filename of the door drop file. This should be sufficient for most BBS
systems. In general, your BBS batch file will look like the following:
CD \FNLSCAN
FNLSCAN -Cfnlscan.cfg -Dc:\bbs\door.sys
CD \BBS
BOARD
* NOTE: If you choose to run FNLScan as a shelled door, calling the BOARD batch
file is unnecessary, and will hose up the node.
If you are running a multinode system, you can use environment variables such
as PCBDRIVE for the drive letter and/or PCBDIR for the subdirectory created by
PCBoard to define the locations of the door drop files. (Note that PCBDRIVE is
only needed if the door is on a different logical drive that your BBS
software). This type of door batch file would use the same batch file for all
nodes, and would like something like:
CD \FNLSCAN
FNLSCAN -Cfnlscan.cfg -D%PCBDRIVE%%PCBDIR%\pcboard.sys
%PCBDRIVE%
CD %PCBDIR%
BOARD
If required, you can provide the COM port information directly to FNLScan by
using the -I and -A command switches:
FNLSCAN -Cfnlscan.cfg -Dc:\bbs\door.sys -I4 -A3f8
where -I is the COM port IRQ line and -A is the port base address (in hex).
FNLScan is capable of using a FOSSIL driver, and automatically detects if you
are running PCBoard /M and uses the appropriate FOSSIL port. However, if you
need to force FNLScan to use a FOSSIL driver, use the -F command switch with
the FOSSIL port number as the argument:
FNLSCAN -Cfnlscan.cfg -Dc:\bbs\door.sys -F0
FNLScan is also capable of directly accessing a Digiboard multiport I/O card.
This can be defined using the -M command switch with the Digiboard channel
number as the argument:
FNLSCAN -Cfnlscan.cfg -Dc:\bbs\door.sys -M1
Note that these parameters can also be passed to the batch file using
environment variables as previously discussed.
CUSTOMIZATION OF FNLSCAN TEXT FILES:
────────────────────────────────────
The WELCOME/WELCOMEG, MENU/MENUG, HELP/HELPG and CLOSE/CLOSEG files may be
modified by the sysop if desired. However, some caveats before you start:
- The files should not be deleted or renamed. FNLScan expects to find these
files as currently named in the currently logged subdirectory.
- FNLScan does not recognize PCBoard @ variables.
- FNLScan does not recognize PCBoard @Xnn color macros; use standard ANSI
codes.
┌────────────────────┐
│ 8. Configuration │
└────────────────────┘
The sample configuration file included in the distribution archive is heavily
commented, but some additional information is provided below:
REG_CODE
The registration code EXACTLY as provided to you on your registration
letter. If this is an unregistered version, comment out this line. Note
that this is case-sensitive, as the serial number, BBS name and sysop name
are all encrypted into this code.
BBS_NAME
The BBS name EXACTLY as provided to you on your registration letter. If
this is an unregistered version, comment out this lines. Note that this is
case-sensitive!
SYSOP_NAME
The sysop name EXACTLY as provided to you on your registration letter. If
this is an unregistered version, comment out this line. You get the picture
by now...
LOG_FILE
FNLScan can write scanning and error information to a disk log file, if
desired. This is the path/filename of the log file for FNLScan to record
its activities; comment it out if you don't want any disk logging.
NODELIST
The full path and filename, except for the extension, to where your
UNCOMPILED nodelist is stored. This must not include an extension! FNLScan
will search the path defined for the latest version of the nodelist. Up to
10 nodelists may be defined for sequential scanning by FNLScan. All
nodelists must comply with Fidonet standards, specifically that each
nodelist must define, at a minimum, one zone and one host. Normally,
pointnet lists do not included this information, and should not be
included.
┌──────────────┐
│ 9. Support │
└──────────────┘
If you require support for FNLScan, I can be contacted by any of the following
means:
∙ Fidonet netmail (node: 1:276/112)
∙ Intelec BBS Doors conferences
∙ RoseNet routed mail (system ID: BB-P)
∙ The ULP Support conference (#42) on Salt Air (PCBoard support BBS)
∙ The Support conference (#2) on my BBS (listed at the top of this
document).
┌─────────────────────────────┐
│ 10. The Future of FNLScan │
└─────────────────────────────┘
FNLScan will be supported as long as I'm in the BBSing business (which will be
quite a while...once it's in your blood, you can never shake it <g>). The
FNLScan system will be continually expanding it's features, so get your
comments in now! Some current plans:
∙ Develop code to read compiled nodelist formats (e.g. Version6,
Version7, Front Door, etc.).
∙ Speed enhancements.
∙ Any ideas from you guys? Thanks! <g>
If you have any other suggestions, contact me by U.S. snail-mail or on my BBS
at the number at the top of this document.
Thanks for giving FNLScan a try!
┌────────────────────────────────┐
│ Appendix A: DOS Errorlevels │
└────────────────────────────────┘
The following is a list of the errorlevels than can be returned by FNLScan:
0 Successful execution
99 Help screen (executing a program with no or an
insufficient number of arguments)
100 Could not close all open files
101 Unknown command line parameter
102 Configuration file not found
103 Excessive number of nodelists configured
104 Unable to access nodelist
110 Unable to allocate heap memory
111 Unable to open or lock disk logging file
200 Undefined error (internal to FNLScan program)